Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix #1543, Rename CFE_TIME_QueryResetVars to CFE_TIME_RestoreFromTimeResetVars #2497

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

thnkslprpt
Copy link
Contributor

Checklist

Describe the contribution

  • Fixes CFE_TIME_QueryResetVars misnomer #1543
    • Rename CFE_TIME_QueryResetVars to CFE_TIME_RestoreFromTimeResetVars given that the function does not just 'query' the time variables, but rather it actually uses them to restore and set the CFE_TIME_ReferenceState_t members (or initialize from scratch if there is no valid reset data).

Note: Could also go with CFE_TIME_RestoreFromResetVars (not including the extra Time qualifier in the name) but that may be less clear given the current names of the reset variables:

/*
** Reset Variables
*/
CFE_ES_ResetVariables_t ResetVars;
/*
** Time variables that are
** preserved on a processor reset
*/
CFE_TIME_ResetVars_t TimeResetVars;

Testing performed
GitHub CI actions all passing successfully (incl. Build + Run, Unit/Functional Tests etc.).

Expected behavior changes
No change.

System(s) tested on
Debian GNU/Linux 11 (bullseye)
Current main branch of cFS bundle.

Contributor Info
Avi Weiss   @thnkslprpt

@@ -104,7 +104,7 @@
* See description in header file for argument/return detail
*
*-----------------------------------------------------------------*/
void CFE_TIME_QueryResetVars(void)
void CFE_TIME_RestoreFromTimeResetVars(void)

Check notice

Code scanning / CodeQL-coding-standard

Function too long Note

CFE_TIME_RestoreFromTimeResetVars has too many lines (78, while 60 are allowed).
@@ -104,7 +104,7 @@
* See description in header file for argument/return detail
*
*-----------------------------------------------------------------*/
void CFE_TIME_QueryResetVars(void)
void CFE_TIME_RestoreFromTimeResetVars(void)

Check notice

Code scanning / CodeQL-coding-standard

Long function without assertion Note

All functions of more than 10 lines should have at least one assertion.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

CFE_TIME_QueryResetVars misnomer
1 participant